Kotools Types/kotools.types.number/PositiveInt/Companion

Companion

object Companion

Contains declarations for holding or building a PositiveInt.

Properties

Link copied to clipboard
val max: StrictlyPositiveInt

The maximum value a PositiveInt can have.

Link copied to clipboard
val min: ZeroInt

The minimum value a PositiveInt can have.

Link copied to clipboard
@ExperimentalKotoolsTypesApi
@ExperimentalSince(version = KotoolsTypesVersion.V4_4_0)
val PositiveInt.Companion.range: NotEmptyRange<PositiveInt>

The range of values a PositiveInt can have.

Functions

Link copied to clipboard
@ExperimentalKotoolsTypesApi
@ExperimentalSince(version = KotoolsTypesVersion.V4_5_0)
fun create(number: Number): PositiveInt

Creates a PositiveInt from the specified number, which may involve rounding or truncation, or throws an IllegalArgumentException if the number is less than zero.

Link copied to clipboard
@ExperimentalKotoolsTypesApi
@ExperimentalSince(version = KotoolsTypesVersion.V4_5_0)
fun createOrNull(number: Number): PositiveInt?

Creates a PositiveInt from the specified number, which may involve rounding or truncation, or returns null if the number is less than zero.

Link copied to clipboard
@Since(version = KotoolsTypesVersion.V3_0_0)
fun random(): PositiveInt

Returns a random PositiveInt.